docs: improve examples for tool calling and cron usage (#26)#28
docs: improve examples for tool calling and cron usage (#26)#28evilroc-pixel wants to merge 1 commit intoopenclaw:mainfrom
Conversation
- Adds examples/daily-standup.lobster showing mixed shell + openclaw.invoke - Improves README with real-world example section - Demonstrates stdin piping, safe arg handling, and cron usage - Addresses confusion reported in openclaw#26 Closes openclaw#26
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9f8960b4e2
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - id: list-tickets | ||
| command: > | ||
| jira issues search "project=${project} AND status=Todo" --json | | ||
| jq -s '[.[] | {id: .key, title: .fields.summary, status: .fields.status.name, priority: .fields.priority.name, assignee: (.fields.assignee.displayName // "unassigned")] | .[0:env.LOBSTER_ARG_limit | tonumber]' 2>/dev/null |
There was a problem hiding this comment.
Fix malformed jq filter in list-tickets step
The jq program in this step has a bracket mismatch (] where the object should close with }), so jq fails to compile and the workflow cannot produce ticket JSON. Because stderr is redirected to /dev/null, this failure is also hard to diagnose for users trying the example, making the new documented pipeline non-runnable as written.
Useful? React with 👍 / 👎.
|
|
||
| - id: summarize | ||
| command: > | ||
| openclaw.invoke --tool llm-task --action json --args-json '{"prompt": "${llm_prompt}"}' |
There was a problem hiding this comment.
Escape llm_prompt before embedding it in --args-json
This command injects ${llm_prompt} directly into a JSON literal inside shell quotes, but README already documents this substitution as raw text replacement. Any prompt containing quotes (or apostrophes) will produce invalid JSON or broken shell quoting, causing openclaw.invoke to fail for common real inputs.
Useful? React with 👍 / 👎.
This comment was marked as spam.
This comment was marked as spam.
|
Thanks for the docs work here. We’re narrowing scope for the next Lobster npm release and not taking overlapping docs/example rewrites right before publish. There are multiple competing PRs covering the same README/examples lane, so we’re going to close this set and do one consolidated docs pass after the release instead of merging overlapping versions piecemeal. I’m leaving the underlying docs need tracked separately, and we can revisit the best pieces from this after the publish. |
This PR adds a comprehensive real-world example that demonstrates how to mix shell commands with Lobster tools (openclaw.invoke), pass data via stdin, and use from OpenClaw cron.
Changes
examples/daily-standup.lobsterworkflow showing:This addresses the confusion reported in #26 where users struggled to compose shell steps with Lobster tools, especially when invoked from OpenClaw.
Fixes #26.
Checklist